Add markers for cluster APIs. #9110

Naarcha-AWS · 2025-01-24T22:31:52Z

Part of issue #9050

Checklist

By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license and subject to the Developers Certificate of Origin.
For more information on following Developer Certificate of Origin and signing off your commits, please check here.

Signed-off-by: Archer <[email protected]>

github-actions · 2025-01-24T22:32:04Z

Thank you for submitting your PR. The PR states are In progress (or Draft) -> Tech review -> Doc review -> Editorial review -> Merged.

Before you submit your PR for doc review, make sure the content is technically accurate. If you need help finding a tech reviewer, tag a maintainer.

When you're ready for doc review, tag the assignee of this PR. The doc reviewer may push edits to the PR directly or leave comments and editorial suggestions for you to address (let us know in a comment if you have a preference). The doc reviewer will arrange for an editorial review.

Signed-off-by: Archer <[email protected]>

_api-reference/cluster-api/cluster-reroute.md

Signed-off-by: Naarcha-AWS <[email protected]>

Signed-off-by: Archer <[email protected]>

Naarcha-AWS · 2025-02-14T17:30:05Z

Sent two fixes for cluster parameter descriptions:

These must be merged before this PR can move forward.

Signed-off-by: Archer <[email protected]>

Co-authored-by: kolchfa-aws <[email protected]> Signed-off-by: Naarcha-AWS <[email protected]>

Signed-off-by: Archer <[email protected]>

Signed-off-by: Naarcha-AWS <[email protected]>

Signed-off-by: Archer <[email protected]>

Signed-off-by: Naarcha-AWS <[email protected]>

Signed-off-by: Archer <[email protected]>

_api-reference/cluster-api/cluster-stats.md

Signed-off-by: Naarcha-AWS <[email protected]>

Naarcha-AWS · 2025-05-05T19:55:10Z

@kolchfa-aws: Are there any additional changes you would like me to make to this before I pass it along to editorial?

kolchfa-aws · 2025-05-05T20:50:05Z

_api-reference/cluster-api/cluster-allocation.md

+| Parameter | Data type | Description | Default |
+| :--- | :--- | :--- | :--- |
+| `include_disk_info` | Boolean | When `true`, returns information about disk usage and shard sizes. | `false` |
+| `include_yes_decisions` | Boolean | When `true`, returns any `YES` decisions in the allocation explanation. `YES` decisions indicate when a particular shard allocation attempt was successful for the given node. | `false` |


Suggested change

| `include_yes_decisions` | Boolean | When `true`, returns any `YES` decisions in the allocation explanation. `YES` decisions indicate when a particular shard allocation attempt was successful for the given node. | `false` |

| `include_yes_decisions` | Boolean | When `true`, returns any `YES` decisions in the allocation explanation. `YES` decisions indicate successful shard allocation attempts for a given node. | `false` |

kolchfa-aws · 2025-05-05T20:51:27Z

_api-reference/cluster-api/cluster-allocation.md

-index | String | The name of the shard's index.
-primary | Boolean | Whether to provide an explanation for the primary shard (true) or its first replica (false), which share the same shard ID.
-shard | Integer | The shard ID that you want an explanation for.
+`current_node` | String | Specifies a node name to return an explanation only if the shard is on that node.


Suggested change

`current_node` | String | Specifies a node name to return an explanation only if the shard is on that node.

`current_node` | String | Returns an explanation only if the shard is located on the `current_node`.

_api-reference/cluster-api/cluster-awareness.md

kolchfa-aws · 2025-05-05T20:55:54Z

_api-reference/cluster-api/cluster-component-template.md

+
+| Parameter | Required | Data type | Description |
+| :--- | :--- | :--- | :--- |
+| `name` | **Required** | String | The name of the component template to create. OpenSearch includes the following built-in component templates: `logs-mappings`, `logs-settings`, `metrics-mappings`, `metrics-settings`, `synthetics-mapping`, and `synthetics-settings`. OpenSearch uses these templates to configure backing indexes for its data streams. If you want to overwrite one of these templates, set the replacement template `version` to a higher value than the current version. If you want to disable all built-in component and index templates, set `stack.templates.enabled` to `false` using the [Cluster Update Settings API]({{site.url}}{{site.baseurl}}/api-reference/cluster-api/cluster-settings/). |


Suggested change

| `name` | **Required** | String | The name of the component template to create. OpenSearch includes the following built-in component templates: `logs-mappings`, `logs-settings`, `metrics-mappings`, `metrics-settings`, `synthetics-mapping`, and `synthetics-settings`. OpenSearch uses these templates to configure backing indexes for its data streams. If you want to overwrite one of these templates, set the replacement template `version` to a higher value than the current version. If you want to disable all built-in component and index templates, set `stack.templates.enabled` to `false` using the [Cluster Update Settings API]({{site.url}}{{site.baseurl}}/api-reference/cluster-api/cluster-settings/). |

| `name` | **Required** | String | The name of the component template to create. OpenSearch includes the following built-in component templates: `logs-mappings`, `logs-settings`, `metrics-mappings`, `metrics-settings`, `synthetics-mapping`, and `synthetics-settings`. OpenSearch uses these templates to configure backing indexes for its data streams. If you want to overwrite one of these templates, set the replacement template `version` to a higher value than the current version. If you want to disable all built-in component and index templates, set `stack.templates.enabled` to `false` using the [Cluster Settings API]({{site.url}}{{site.baseurl}}/api-reference/cluster-api/cluster-settings/). |

Are these values auto-generated? Also, is there documentation for these? Would be nice to link to that documentation here.

kolchfa-aws · 2025-05-05T20:57:21Z

_api-reference/cluster-api/cluster-component-template.md

+| :--- | :--- | :--- | :--- |
+| `cluster_manager_timeout` | String | The amount of time to wait for a response from the cluster manager node. For more information about supported time units, see [Common parameters]({{site.url}}{{site.baseurl}}/api-reference/common-parameters/#time-units). | N/A |
+| `create` | Boolean | When `true`, this request cannot replace or update existing component templates. | `false` |
+| `timeout` | String | A duration. Units can be `nanos`, `micros`, `ms` (milliseconds), `s` (seconds), `m` (minutes), `h` (hours) and `d` (days). Also accepts "0" without a unit and "-1" to indicate an unspecified value. | N/A |


Suggested change

| `timeout` | String | A duration. Units can be `nanos`, `micros`, `ms` (milliseconds), `s` (seconds), `m` (minutes), `h` (hours) and `d` (days). Also accepts "0" without a unit and "-1" to indicate an unspecified value. | N/A |

| `timeout` | String | A duration. Units can be `nanos`, `micros`, `ms` (milliseconds), `s` (seconds), `m` (minutes), `h` (hours) and `d` (days). Also accepts `0` without a unit and `-1` to indicate an unspecified value. | N/A |

kolchfa-aws · 2025-05-05T21:38:46Z

_api-reference/cluster-api/cluster-state.md

+| `ignore_unavailable` | Boolean | Whether the specified concrete indexes should be ignored when unavailable (missing or closed). |
+| `local` | Boolean | Whether to return information from the local node only instead of from the cluster manager node. _(Default: `false`)_ |
+| `wait_for_metadata_version` | Integer | Wait for the metadata version to be equal or greater than the specified metadata version. |
+| `wait_for_timeout` | String | The maximum time to wait for `wait_for_metadata_version` before timing out. |


As a user, I'm not sure what string I can put in this timeout. This should link to a time unit explanation. Please apply to all time values.

kolchfa-aws · 2025-05-05T21:39:49Z

_api-reference/cluster-api/cluster-state.md

+    }
+  }
+}
+```


Without this section, this document is incomplete. I would then remove this file from this PR and raise a separate one.

_api-reference/cluster-api/cluster-voting-configuration.md

kolchfa-aws · 2025-05-05T21:41:55Z

_api-reference/cluster-api/cluster-voting-configuration.md

+| :--- | :--- | :--- |
+| `node_ids` | List or String | A comma-separated list of node IDs to exclude from the voting configuration. When using this setting, you cannot also specify `node_names`. |
+| `node_names` | List or String | A comma-separated list of node names to exclude from the voting configuration. When using this setting, you cannot also specify `node_ids`. |
+| `timeout` | String | When adding a voting configuration exclusion, the API waits for the specified nodes to be excluded from the voting configuration before returning a response. If the timeout expires before the appropriate condition is satisfied, the request fails and returns an error. |


Yes, the defaults are set in the code. If the spec does not reflect the defaults, we should update the spec.

_api-reference/cluster-api/cluster-weighted-routing.md

Signed-off-by: Naarcha-AWS <[email protected]>

Add markers for cluster APIs.

8234ec2

Signed-off-by: Archer <[email protected]>

github-actions bot assigned Naarcha-AWS Jan 24, 2025

Naarcha-AWS and others added 4 commits January 24, 2025 17:42

Merge branch 'main' into cluster-apis

9ac0957

Add rest of cluster inserts

7f0f39b

Signed-off-by: Archer <[email protected]>

Merge branch 'main' into cluster-apis

44d9145

Adjust tables. Add example requests and responses.

94b4cd1

Signed-off-by: Archer <[email protected]>

Naarcha-AWS marked this pull request as ready for review February 4, 2025 20:45

Naarcha-AWS requested review from kolchfa-aws, AMoo-Miki, natebower, dlvenable and epugh as code owners February 4, 2025 20:45

Merge branch 'main' into cluster-apis

eff3c78

Naarcha-AWS added 4 - Doc review PR: Doc review in progress backport 2.18 PR: Backport label for 2.18 labels Feb 4, 2025

Naarcha-AWS commented Feb 4, 2025

View reviewed changes

_api-reference/cluster-api/cluster-reroute.md Outdated Show resolved Hide resolved

Naarcha-AWS commented Feb 4, 2025

View reviewed changes

_api-reference/cluster-api/cluster-reroute.md Outdated Show resolved Hide resolved

Naarcha-AWS added 3 commits February 4, 2025 14:53

Apply suggestions from code review

645f9e1

Signed-off-by: Naarcha-AWS <[email protected]>

Apply suggestions from code review

b713b3b

Signed-off-by: Naarcha-AWS <[email protected]>

Merge branch 'main' into cluster-apis

bab9e3c

Naarcha-AWS added backport 2.19 and removed backport 2.18 PR: Backport label for 2.18 labels Feb 12, 2025

Naarcha-AWS and others added 4 commits February 12, 2025 16:01

Merge branch 'main' into cluster-apis

5607382

Merge branch 'main' into cluster-apis

5f60253

Remove depracated parameters.

7550e90

Signed-off-by: Archer <[email protected]>

One last deprecated parameter

5fbb2c4

Signed-off-by: Archer <[email protected]>

Description additions.

19b60e4

Signed-off-by: Archer <[email protected]>

Naarcha-AWS removed the 4 - Doc review PR: Doc review in progress label Feb 20, 2025

Naarcha-AWS and others added 20 commits February 21, 2025 14:29

Apply suggestions from code review

403e330

Co-authored-by: kolchfa-aws <[email protected]> Signed-off-by: Naarcha-AWS <[email protected]>

Apply suggestions from code review

999aef7

Co-authored-by: kolchfa-aws <[email protected]> Signed-off-by: Naarcha-AWS <[email protected]>

Apply suggestions from code review

9ea5bc7

Co-authored-by: kolchfa-aws <[email protected]> Signed-off-by: Naarcha-AWS <[email protected]>

Fix other marker items and other feedback

93cfb7b

Signed-off-by: Archer <[email protected]>

Fix code examples

96a153f

Signed-off-by: Archer <[email protected]>

Merge branch 'main' into cluster-apis

437d733

Merge branch 'main' into cluster-apis

00f78ef

Remove query parameters section

1028bcd

Signed-off-by: Naarcha-AWS <[email protected]>

Fix example request

aaaa1d1

Signed-off-by: Naarcha-AWS <[email protected]>

Add incoporated spec feedback

66dd54d

Signed-off-by: Archer <[email protected]>

Update cluster-reroute.md

276d0fe

Signed-off-by: Naarcha-AWS <[email protected]>

Additional feedback

bb0b96b

Signed-off-by: Archer <[email protected]>

Remove deprecated setting

6862a85

Signed-off-by: Archer <[email protected]>

Merge branch 'main' into cluster-apis

605ee18

Add latest spec edits

9f8070c

Signed-off-by: Archer <[email protected]>

Merge branch 'main' into cluster-apis

ec2f046

Merge branch 'main' into cluster-apis

9bba42f

Add updated spec information

1abf796

Signed-off-by: Archer <[email protected]>

Merge branch 'main' into cluster-apis

f471be0

Merge branch 'main' into cluster-apis

b1651bd

Naarcha-AWS commented Apr 3, 2025

View reviewed changes

_api-reference/cluster-api/cluster-stats.md Outdated Show resolved Hide resolved

Apply suggestions from code review

8aeefa5

Signed-off-by: Naarcha-AWS <[email protected]>

Naarcha-AWS mentioned this pull request May 5, 2025

Extend _cluster docs for _cluster/reroute and _cluster/state #9811

Closed

Merge branch 'main' into cluster-apis

6b0f332

kolchfa-aws reviewed May 6, 2025

View reviewed changes

Naarcha-AWS commented May 6, 2025

View reviewed changes

_api-reference/cluster-api/cluster-weighted-routing.md Outdated Show resolved Hide resolved

Apply suggestions from code review

ae591b2

Signed-off-by: Naarcha-AWS <[email protected]>

kolchfa-aws added backport 3.0 and removed backport 2.19 labels May 6, 2025

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add markers for cluster APIs. #9110

Add markers for cluster APIs. #9110

Naarcha-AWS commented Jan 24, 2025

github-actions bot commented Jan 24, 2025

Naarcha-AWS commented Feb 14, 2025

Naarcha-AWS commented May 5, 2025

kolchfa-aws May 5, 2025

kolchfa-aws May 5, 2025

kolchfa-aws May 5, 2025

kolchfa-aws May 5, 2025

kolchfa-aws May 5, 2025

kolchfa-aws May 5, 2025

kolchfa-aws May 5, 2025

kolchfa-aws May 5, 2025

	\| `include_yes_decisions` \| Boolean \| When `true`, returns any `YES` decisions in the allocation explanation. `YES` decisions indicate when a particular shard allocation attempt was successful for the given node. \| `false` \|
	\| `include_yes_decisions` \| Boolean \| When `true`, returns any `YES` decisions in the allocation explanation. `YES` decisions indicate successful shard allocation attempts for a given node. \| `false` \|

	`current_node` \| String \| Specifies a node name to return an explanation only if the shard is on that node.
	`current_node` \| String \| Returns an explanation only if the shard is located on the `current_node`.

	\| `timeout` \| String \| A duration. Units can be `nanos`, `micros`, `ms` (milliseconds), `s` (seconds), `m` (minutes), `h` (hours) and `d` (days). Also accepts "0" without a unit and "-1" to indicate an unspecified value. \| N/A \|
	\| `timeout` \| String \| A duration. Units can be `nanos`, `micros`, `ms` (milliseconds), `s` (seconds), `m` (minutes), `h` (hours) and `d` (days). Also accepts `0` without a unit and `-1` to indicate an unspecified value. \| N/A \|

Add markers for cluster APIs. #9110

Are you sure you want to change the base?

Add markers for cluster APIs. #9110

Conversation

Naarcha-AWS commented Jan 24, 2025

Checklist

github-actions bot commented Jan 24, 2025

Naarcha-AWS commented Feb 14, 2025

Naarcha-AWS commented May 5, 2025

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment